GET WellPurposeTypes?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves well purpose types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
take |
Number of well purpose types to retrieve. Default is all wellPurpose types |
integer |
None. |
skip |
Number of well purpose types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the well purpose types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of well purpose types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of WellPurposeType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "WellPurposeTypeId": "b4ab482e-8941-4193-bf81-cfecda12ccf4", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a70b5a11-065a-42ed-ba78-334774937a47", "CreateDate": "2024-04-28T21:45:47.8586663-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:45:47.8586663-07:00", "LastModifiedUser": "sample string 7" }, { "WellPurposeTypeId": "b4ab482e-8941-4193-bf81-cfecda12ccf4", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a70b5a11-065a-42ed-ba78-334774937a47", "CreateDate": "2024-04-28T21:45:47.8586663-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:45:47.8586663-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }